<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.hackystat.telemetry.analyzer.configuration;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import org.hackystat.sensorbase.resource.projects.jaxb.Project;<a name="line.3"></a>
<FONT color="green">004</FONT>    <a name="line.4"></a>
<FONT color="green">005</FONT>    /**<a name="line.5"></a>
<FONT color="green">006</FONT>     * The level of sharing associated with a telemetry chart or report definition.<a name="line.6"></a>
<FONT color="green">007</FONT>     * The share scope can be global, project or private (not shared).<a name="line.7"></a>
<FONT color="green">008</FONT>     * &lt;p&gt;<a name="line.8"></a>
<FONT color="green">009</FONT>     * V8 Notes:  Initially, all scope will be global.  This is an enumerated type and<a name="line.9"></a>
<FONT color="green">010</FONT>     * really should be implemented that way. <a name="line.10"></a>
<FONT color="green">011</FONT>     * <a name="line.11"></a>
<FONT color="green">012</FONT>     * @author (Cedric) Qin Zhang  <a name="line.12"></a>
<FONT color="green">013</FONT>     */<a name="line.13"></a>
<FONT color="green">014</FONT>    public class ShareScope {<a name="line.14"></a>
<FONT color="green">015</FONT>    <a name="line.15"></a>
<FONT color="green">016</FONT>      private static final int GLOBAL = 100;<a name="line.16"></a>
<FONT color="green">017</FONT>      private static final int PROJECT = 200;<a name="line.17"></a>
<FONT color="green">018</FONT>      private static final int PRIVATE = 300;<a name="line.18"></a>
<FONT color="green">019</FONT>    <a name="line.19"></a>
<FONT color="green">020</FONT>      private static final String GLOBAL_STRING = "Global";<a name="line.20"></a>
<FONT color="green">021</FONT>      private static final String PRIVATE_STRING = "Not Shared";<a name="line.21"></a>
<FONT color="green">022</FONT>      //private static final String PROJECT_PREFIX_STRING = "Project@@@";<a name="line.22"></a>
<FONT color="green">023</FONT>    <a name="line.23"></a>
<FONT color="green">024</FONT>      private static final ShareScope GLOBAL_SHARE_SCOPE = new ShareScope(GLOBAL, null);<a name="line.24"></a>
<FONT color="green">025</FONT>      private static final ShareScope PRIVATE_SHARE_SCOPE = new ShareScope(PRIVATE, null);<a name="line.25"></a>
<FONT color="green">026</FONT>    <a name="line.26"></a>
<FONT color="green">027</FONT>      private int scope;<a name="line.27"></a>
<FONT color="green">028</FONT>      private Project project;<a name="line.28"></a>
<FONT color="green">029</FONT>    <a name="line.29"></a>
<FONT color="green">030</FONT>      /**<a name="line.30"></a>
<FONT color="green">031</FONT>       * Private constructor. User cannot call this method.<a name="line.31"></a>
<FONT color="green">032</FONT>       * <a name="line.32"></a>
<FONT color="green">033</FONT>       * @param shareScope The share scope.<a name="line.33"></a>
<FONT color="green">034</FONT>       * @param project The project. It must be null if share scope is global or<a name="line.34"></a>
<FONT color="green">035</FONT>       *          private. It must not be null if share scope is project.<a name="line.35"></a>
<FONT color="green">036</FONT>       */<a name="line.36"></a>
<FONT color="green">037</FONT>      private ShareScope(int shareScope, Project project) {<a name="line.37"></a>
<FONT color="green">038</FONT>        this.scope = shareScope;<a name="line.38"></a>
<FONT color="green">039</FONT>        this.project = project;<a name="line.39"></a>
<FONT color="green">040</FONT>      }<a name="line.40"></a>
<FONT color="green">041</FONT>    <a name="line.41"></a>
<FONT color="green">042</FONT>      /**<a name="line.42"></a>
<FONT color="green">043</FONT>       * Gets the global share scope.<a name="line.43"></a>
<FONT color="green">044</FONT>       * <a name="line.44"></a>
<FONT color="green">045</FONT>       * @return The global share scope.<a name="line.45"></a>
<FONT color="green">046</FONT>       */<a name="line.46"></a>
<FONT color="green">047</FONT>      public static ShareScope getGlobalShareScope() {<a name="line.47"></a>
<FONT color="green">048</FONT>        return GLOBAL_SHARE_SCOPE;<a name="line.48"></a>
<FONT color="green">049</FONT>      }<a name="line.49"></a>
<FONT color="green">050</FONT>    <a name="line.50"></a>
<FONT color="green">051</FONT>      /**<a name="line.51"></a>
<FONT color="green">052</FONT>       * Gets the project share scope.<a name="line.52"></a>
<FONT color="green">053</FONT>       * <a name="line.53"></a>
<FONT color="green">054</FONT>       * @param project The project.<a name="line.54"></a>
<FONT color="green">055</FONT>       * @return The project share scope. Always Global in V8.<a name="line.55"></a>
<FONT color="green">056</FONT>       */<a name="line.56"></a>
<FONT color="green">057</FONT>      public static ShareScope getProjectShareScope(Project project) {<a name="line.57"></a>
<FONT color="green">058</FONT>        if (project == null) {<a name="line.58"></a>
<FONT color="green">059</FONT>          throw new IllegalArgumentException("Project cannot be null");<a name="line.59"></a>
<FONT color="green">060</FONT>        }<a name="line.60"></a>
<FONT color="green">061</FONT>        return new ShareScope(PROJECT, project);<a name="line.61"></a>
<FONT color="green">062</FONT>      }<a name="line.62"></a>
<FONT color="green">063</FONT>    <a name="line.63"></a>
<FONT color="green">064</FONT>      /**<a name="line.64"></a>
<FONT color="green">065</FONT>       * Gets the private share scope.<a name="line.65"></a>
<FONT color="green">066</FONT>       * <a name="line.66"></a>
<FONT color="green">067</FONT>       * @return The private share scope.<a name="line.67"></a>
<FONT color="green">068</FONT>       */<a name="line.68"></a>
<FONT color="green">069</FONT>      public static ShareScope getPrivateShareScope() {<a name="line.69"></a>
<FONT color="green">070</FONT>        return PRIVATE_SHARE_SCOPE;<a name="line.70"></a>
<FONT color="green">071</FONT>      }<a name="line.71"></a>
<FONT color="green">072</FONT>    <a name="line.72"></a>
<FONT color="green">073</FONT>      /**<a name="line.73"></a>
<FONT color="green">074</FONT>       * Gets the project if the the share scope is project.<a name="line.74"></a>
<FONT color="green">075</FONT>       * <a name="line.75"></a>
<FONT color="green">076</FONT>       * @return The project.<a name="line.76"></a>
<FONT color="green">077</FONT>       * <a name="line.77"></a>
<FONT color="green">078</FONT>       * @throws TelemetryConfigurationException If the share scope is not project.<a name="line.78"></a>
<FONT color="green">079</FONT>       */<a name="line.79"></a>
<FONT color="green">080</FONT>      public Project getProject() throws TelemetryConfigurationException {<a name="line.80"></a>
<FONT color="green">081</FONT>        if (!this.isProject()) {<a name="line.81"></a>
<FONT color="green">082</FONT>          throw new TelemetryConfigurationException("The share scope is not project.");<a name="line.82"></a>
<FONT color="green">083</FONT>        }<a name="line.83"></a>
<FONT color="green">084</FONT>        return this.project;<a name="line.84"></a>
<FONT color="green">085</FONT>      }<a name="line.85"></a>
<FONT color="green">086</FONT>    <a name="line.86"></a>
<FONT color="green">087</FONT>      /**<a name="line.87"></a>
<FONT color="green">088</FONT>       * Checks whether is share scope is global.<a name="line.88"></a>
<FONT color="green">089</FONT>       * <a name="line.89"></a>
<FONT color="green">090</FONT>       * @return True if share scope is global.<a name="line.90"></a>
<FONT color="green">091</FONT>       */<a name="line.91"></a>
<FONT color="green">092</FONT>      public boolean isGlobal() {<a name="line.92"></a>
<FONT color="green">093</FONT>        return GLOBAL == this.scope;<a name="line.93"></a>
<FONT color="green">094</FONT>      }<a name="line.94"></a>
<FONT color="green">095</FONT>    <a name="line.95"></a>
<FONT color="green">096</FONT>      /**<a name="line.96"></a>
<FONT color="green">097</FONT>       * Checks whether is share scope is project.<a name="line.97"></a>
<FONT color="green">098</FONT>       * <a name="line.98"></a>
<FONT color="green">099</FONT>       * @return True if share scope is project.<a name="line.99"></a>
<FONT color="green">100</FONT>       */<a name="line.100"></a>
<FONT color="green">101</FONT>      public boolean isProject() {<a name="line.101"></a>
<FONT color="green">102</FONT>        return PROJECT == this.scope;<a name="line.102"></a>
<FONT color="green">103</FONT>      }<a name="line.103"></a>
<FONT color="green">104</FONT>    <a name="line.104"></a>
<FONT color="green">105</FONT>      /**<a name="line.105"></a>
<FONT color="green">106</FONT>       * Checks whether is share scope is private.<a name="line.106"></a>
<FONT color="green">107</FONT>       * <a name="line.107"></a>
<FONT color="green">108</FONT>       * @return True if share scope is private.<a name="line.108"></a>
<FONT color="green">109</FONT>       */<a name="line.109"></a>
<FONT color="green">110</FONT>      public boolean isPrivate() {<a name="line.110"></a>
<FONT color="green">111</FONT>        return PRIVATE == this.scope;<a name="line.111"></a>
<FONT color="green">112</FONT>      }<a name="line.112"></a>
<FONT color="green">113</FONT>    <a name="line.113"></a>
<FONT color="green">114</FONT>      /**<a name="line.114"></a>
<FONT color="green">115</FONT>       * Gets the string representation of this instance.<a name="line.115"></a>
<FONT color="green">116</FONT>       * <a name="line.116"></a>
<FONT color="green">117</FONT>       * @return The string representation.<a name="line.117"></a>
<FONT color="green">118</FONT>       */<a name="line.118"></a>
<FONT color="green">119</FONT>      @Override<a name="line.119"></a>
<FONT color="green">120</FONT>      public String toString() {<a name="line.120"></a>
<FONT color="green">121</FONT>        if (this.isGlobal()) {<a name="line.121"></a>
<FONT color="green">122</FONT>          return GLOBAL_STRING;<a name="line.122"></a>
<FONT color="green">123</FONT>        }<a name="line.123"></a>
<FONT color="green">124</FONT>        else if (this.isProject()) {<a name="line.124"></a>
<FONT color="green">125</FONT>          return "Project: " + this.project.getName();<a name="line.125"></a>
<FONT color="green">126</FONT>        }<a name="line.126"></a>
<FONT color="green">127</FONT>        else {<a name="line.127"></a>
<FONT color="green">128</FONT>          // must be private<a name="line.128"></a>
<FONT color="green">129</FONT>          return PRIVATE_STRING;<a name="line.129"></a>
<FONT color="green">130</FONT>        }<a name="line.130"></a>
<FONT color="green">131</FONT>      }<a name="line.131"></a>
<FONT color="green">132</FONT>    <a name="line.132"></a>
<FONT color="green">133</FONT>      /**<a name="line.133"></a>
<FONT color="green">134</FONT>       * Serialized this instance to a string. Note that this string may not be user<a name="line.134"></a>
<FONT color="green">135</FONT>       * readable.<a name="line.135"></a>
<FONT color="green">136</FONT>       * <a name="line.136"></a>
<FONT color="green">137</FONT>       * @return The serialized form.<a name="line.137"></a>
<FONT color="green">138</FONT>       */<a name="line.138"></a>
<FONT color="green">139</FONT>      public String serializeToString() {<a name="line.139"></a>
<FONT color="green">140</FONT>        if (this.isGlobal()) {<a name="line.140"></a>
<FONT color="green">141</FONT>          return GLOBAL_STRING;<a name="line.141"></a>
<FONT color="green">142</FONT>        }<a name="line.142"></a>
<FONT color="green">143</FONT>        else if (this.isProject()) {<a name="line.143"></a>
<FONT color="green">144</FONT>          return "Project@@@" + this.project.getName();<a name="line.144"></a>
<FONT color="green">145</FONT>        }<a name="line.145"></a>
<FONT color="green">146</FONT>        else {<a name="line.146"></a>
<FONT color="green">147</FONT>          // must be private<a name="line.147"></a>
<FONT color="green">148</FONT>          return PRIVATE_STRING;<a name="line.148"></a>
<FONT color="green">149</FONT>        }<a name="line.149"></a>
<FONT color="green">150</FONT>      }<a name="line.150"></a>
<FONT color="green">151</FONT>    <a name="line.151"></a>
<FONT color="green">152</FONT>      /**<a name="line.152"></a>
<FONT color="green">153</FONT>       * Tests whether this instance equals another instance.<a name="line.153"></a>
<FONT color="green">154</FONT>       * <a name="line.154"></a>
<FONT color="green">155</FONT>       * @param obj Another instance.<a name="line.155"></a>
<FONT color="green">156</FONT>       * <a name="line.156"></a>
<FONT color="green">157</FONT>       * @return True if they are equal.<a name="line.157"></a>
<FONT color="green">158</FONT>       */<a name="line.158"></a>
<FONT color="green">159</FONT>      @Override<a name="line.159"></a>
<FONT color="green">160</FONT>      public boolean equals(Object obj) {<a name="line.160"></a>
<FONT color="green">161</FONT>        if (!(obj instanceof ShareScope)) {<a name="line.161"></a>
<FONT color="green">162</FONT>          return false;<a name="line.162"></a>
<FONT color="green">163</FONT>        }<a name="line.163"></a>
<FONT color="green">164</FONT>        ShareScope another = (ShareScope) obj;<a name="line.164"></a>
<FONT color="green">165</FONT>        if (this.scope == another.scope) {<a name="line.165"></a>
<FONT color="green">166</FONT>          if (this.project == null) {<a name="line.166"></a>
<FONT color="green">167</FONT>            return another.project == null;<a name="line.167"></a>
<FONT color="green">168</FONT>          }<a name="line.168"></a>
<FONT color="green">169</FONT>          else {<a name="line.169"></a>
<FONT color="green">170</FONT>            return this.project.equals(another.project);<a name="line.170"></a>
<FONT color="green">171</FONT>          }<a name="line.171"></a>
<FONT color="green">172</FONT>        }<a name="line.172"></a>
<FONT color="green">173</FONT>        else {<a name="line.173"></a>
<FONT color="green">174</FONT>          return false;<a name="line.174"></a>
<FONT color="green">175</FONT>        }<a name="line.175"></a>
<FONT color="green">176</FONT>      }<a name="line.176"></a>
<FONT color="green">177</FONT>    <a name="line.177"></a>
<FONT color="green">178</FONT>      /**<a name="line.178"></a>
<FONT color="green">179</FONT>       * Gets the hash code.<a name="line.179"></a>
<FONT color="green">180</FONT>       * <a name="line.180"></a>
<FONT color="green">181</FONT>       * @return The hash code.<a name="line.181"></a>
<FONT color="green">182</FONT>       */<a name="line.182"></a>
<FONT color="green">183</FONT>      @Override<a name="line.183"></a>
<FONT color="green">184</FONT>      public int hashCode() {<a name="line.184"></a>
<FONT color="green">185</FONT>        return (this.project == null) ? this.scope : this.project.hashCode();<a name="line.185"></a>
<FONT color="green">186</FONT>      }<a name="line.186"></a>
<FONT color="green">187</FONT>    }<a name="line.187"></a>




























































</PRE>
</BODY>
</HTML>
